/*
 * Copyright 2019 VicTools.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.github.victools.jsonschema.module.swagger15;

/**
 * Flags to enable/disable certain aspects of the {@link SwaggerModule}'s processing.
 */
public enum SwaggerOption {
    /**
     * Use this option to ignore properties annotated with {@code @ApiModelProperty(hidden = true)}.
     */
    IGNORING_HIDDEN_PROPERTIES,
    /**
     * Use this option to apply alternative property names specified via {@code @ApiModelProperty(name = "...")}.
     */
    ENABLE_PROPERTY_NAME_OVERRIDES,
    /**
     * Use this option to NOT set the "description" property (based on {@code @ApiModel(description = "...")}).
     */
    NO_APIMODEL_DESCRIPTION,
    /**
     * Use this option to NOT set the "title" property (based on {@code @ApiModel(value = "...")}).
     */
    NO_APIMODEL_TITLE;
}
